Skip to content

Improve Account and Profile Documentation Frontmatter and Intro Wording #39260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve Account and Profile Documentation Frontmatter and Intro Wording #39260

wants to merge 1 commit into from
+6 −4

Conversation

NirajDN
Copy link

@NirajDN NirajDN commented Jul 11, 2025

Why:

The current account and profile documentation frontmatter and intro text were a bit wordy and could be clearer. Improving these will help users understand the purpose of the page quickly and improve the maintainability of the YAML frontmatter for future edits.

What's being changed (if available, include any code snippets, screenshots, or gifs):

  • Reworded the intro to use more concise and natural language:
    • Changed "adjusting the settings" to "customizing your personal account settings"
    • Changed "managing the notifications you receive" to "managing your notification preferences"
  • Converted the intro string from single-quoted to multi-line YAML format for easier readability and editing.
  • Cleaned up YAML formatting and indentation for better consistency.
  • No visual UI changes; documentation metadata improvements only.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Contributor: NirajDN

@welcome Welcome
Copy link

welcome bot commented Jul 11, 2025

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 11, 2025
@github-actions GitHub Actions
Copy link
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
account-and-profile/index.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@Sharra-writes
Copy link
Contributor

@NirajDN Thanks for opening a PR! I do like the gist of your rewording for the frontmatter intro, but I will note that all our articles are "Capitalized first word only," never "Capitalize Like a Book Title." That's just part of our style guide. Formatting punctuation also has to all stay the same, so the intro needs to be in single quotes. I'll have to spin up a preview to make sure the change in the link formatting works. I'll take a look and get back to you. 💛

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team account-and-profile Content relating to account and profile and removed triage Do not begin working on this issue until triaged by the team labels Jul 11, 2025
@NirajDN
Copy link
Author

NirajDN commented Jul 11, 2025 •
edited
Loading

@Sharra-writes Thanks for the thoughtful feedback, 😊
I really appreciate the clarification around the style guide , I’ll make those adjustments to match the capitalization and punctuation rules. Excited to see how the preview looks, and happy to revise anything else if needed. Just let me know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
account-and-profile Content relating to account and profile content This issue or pull request belongs to the Docs Content team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@NirajDN @Sharra-writes